-GNOME-SHELL(1)
-=============
-:man manual: User Commands
-:man source: GNOME-SHELL
-:doctype: manpage
-:date: December 2020
-
-NAME
-----
-gnome-shell - Graphical shell for the GNOME desktop
+===========
+gnome-shell
+===========
+
+-------------------------------------
+Graphical shell for the GNOME desktop
+-------------------------------------
+
+:Manual section: 1
+:Manual group: User Commands
SYNOPSIS
--------
-*gnome-shell* ['OPTION'...]
+**gnome-shell** [*OPTION*...]
DESCRIPTION
-----------
OPTIONS
-------
-*--wayland*::
-Run as a wayland compositor
+``--wayland``
+
+ Run as a wayland compositor
+
+``--display-server``
+
+ Run as a full display server, rather than nested
+
+``--nested``
+
+ Run as a nested compositor
+
+``--no-x11``
+
+ Run wayland compositor without starting Xwayland
+
+``--x11``
+
+ Run with X11 backend
+
+``--wayland-display``\ =\ *DISPLAY*
+
+ Wayland display name to use
+
+``-d``, ``--display``\ =\ *DISPLAY*
+
+ X display to use
+
+``-r``, ``--replace``
+
+ Replace the running window manager
+
+``--sm-disable``
-*--display-server*::
-Run as a full display server, rather than nested
+ Disable connection to the session manager
-*--nested*::
-Run as a nested compositor
+``--sm-client-id``\ =\ *ID*
-*--no-x11*::
-Run wayland compositor without starting Xwayland
+ Specify session management *ID*
-*--x11*::
-Run with X11 backend
+``--sm-save-file``\ =\ *FILE*
-*--wayland-display*='DISPLAY'::
-Wayland display name to use
+ Initialize session from *FILE*
-*-d*, *--display*='DISPLAY'::
-X display to use
+``--sync``
-*-r*, *--replace*::
-Replace the running window manager
+ Make X calls synchronous
-*--sm-disable*::
-Disable connection to the session manager
+``--mode=MODE``
-*--sm-client-id*='ID'::
-Specify session management 'ID'
+ Use a specific mode, e.g. "gdm" for login screen
-*--sm-save-file*='FILE'::
-Initialize session from 'FILE'
+``--list-modes``
-*--sync*::
-Make X calls synchronous
+ List possible modes and exit
-*--mode*='MODE'::
-Use a specific mode, e.g. "gdm" for login screen
+``--version``
-*--list-modes*::
-List possible modes and exit
+ Print version and exit
-*--version*::
-Print version and exit
+``--help``
-*--help*::
-Display help and exit
+ Display help and exit
FILES
-----
-GNOME-EXTENSIONS(1)
-===================
-:man manual: User Commands
-:man source: GNOME-EXTENSIONS-TOOL
-:doctype: manpage
-:date: August 2018
-
-NAME
-----
-gnome-extensions - Command line tool for managing GNOME extensions
+================
+gnome-extensions
+================
+
+-----------------------------------------------
+Command line tool for managing GNOME extensions
+-----------------------------------------------
+
+:Manual section: 1
+:Manual group: User Commands
SYNOPSIS
--------
-*gnome-extensions* help ['COMMAND']
-*gnome-extensions* version
+| **gnome-extensions** help [*COMMAND*]
+| **gnome-extensions** version
+| **gnome-extensions** enable *UUID*
+| **gnome-extensions** disable *UUID*
+| **gnome-extensions** reset *UUID*
+| **gnome-extensions** info *UUID*
+| **gnome-extensions** show *UUID*
+| **gnome-extensions** list [*OPTION*...]
+| **gnome-extensions** prefs *UUID*
+| **gnome-extensions** create [*OPTION*...]
+| **gnome-extensions** pack [*OPTION*...]
+| **gnome-extensions** install [*OPTION*...] *PACK*
+| **gnome-extensions** uninstall *UUID*
-*gnome-extensions* enable 'UUID'
+DESCRIPTION
+-----------
+``gnome-extensions`` is a utility that makes some common GNOME extensions
+operations available on the command line.
-*gnome-extensions* disable 'UUID'
+COMMON OPTIONS
+--------------
+All commands except for ``help`` and ``version`` handle the following options:
-*gnome-extensions* reset 'UUID'
+``--quiet``, ``-q``
-*gnome-extensions* info 'UUID'
+ Do not print error messages
-*gnome-extensions* show 'UUID'
+COMMANDS
+--------
+``help`` [*COMMAND*]
-*gnome-extensions* list ['OPTION'...]
+ Displays a short synopsis of the available commands or provides
+ detailed help on a specific command.
-*gnome-extensions* prefs 'UUID'
+``version``
-*gnome-extensions* create ['OPTION'...]
+ Prints the program version.
-*gnome-extensions* pack ['OPTION'...]
+``enable`` *UUID*
-*gnome-extensions* install ['OPTION'...] 'PACK'
+ Enables the extension identified by *UUID*.
-*gnome-extensions* uninstall 'UUID'
+ The command will not detect any errors from the extension itself, use the
+ ``info`` command to confirm that the extension state is *ACTIVE*.
-DESCRIPTION
------------
-*gnome-extensions* is a utility that makes some common GNOME extensions
-operations available on the command line.
+ If the extension is already enabled, the command will do nothing.
-COMMON OPTIONS
---------------
-All commands except for *help* and *version* handle the following options:
+``disable`` *UUID*
-*--quiet*, *-q*::
-Do not print error messages
+ Disables the extension identified by *UUID*.
-COMMANDS
---------
-*help* ['COMMAND']::
-Displays a short synopsis of the available commands or provides
-detailed help on a specific command.
+ If the extension is not enabled, the command will do nothing.
+
+``reset`` *UUID*
+
+ Reset the extension identified by *UUID*.
+
+ The extension will be disabled in GNOME, but may be enabled by other sessions
+ like GNOME Classic.
+
+``info`` *UUID*
+
+ Show details of the extension identified by *UUID*, including name,
+ description and state.
+
+``show`` *UUID*
+
+ Synonym of info.
+
+``list`` [*OPTION*...]
+
+ Displays a list of installed extensions.
+
+ **Options**
+
+ ``--user``
+
+ Include extensions installed in the user's ``$HOME``
+
+ ``--system``
+
+ Include extensions installed in the system
+
+ ``--enabled``
+
+ Include enabled extensions
+
+ ``--disabled``
+
+ Include disabled extensions
+
+ ``--active``
+
+ Only include extensions in active state
+
+ ``--inactive``
+
+ Only include extensions in inactive state
+
+ ``--prefs``
+
+ Only include extensions with preferences
+
+ ``--updates``
+
+ Only include extensions with pending updates
+
+ ``-d``, ``--details``
+
+ Show some extra information for each extension
+
+``prefs`` *UUID*
+
+ Open the preference dialog of the extension identified by *UUID*.
+
+
+``create`` [*OPTION*...]
+
+ Creates a new extension from a template.
+
+ **Options**
+
+ ``--name``\ =\ *NAME*
+
+ Set the user-visible name in the extension's metadata
+ to *NAME*
+
+ ``--description``\ =\ *DESC*
+
+ Set the description in the extension's metadata to *DESC*
+
+ ``--uuid``\ =\ *UUID*
+
+ Set the unique extension ID in the metadata to *UUID*
+
+ ``--gettext-domain``\ =\ *DOMAIN*
+
+ Set the gettext domain used by the extension
+
+ ``--settings-schema``\ =\ *SCHEMA*
+
+ Set the GSettings schema used by the extension
+
+ ``--template``\ =\ *TEMPLATE*
+
+ Use *TEMPLATE* as base for the new extension
+
+ ``--prefs``
+
+ Include a prefs.js template
+
+ ``-i``,
+ ``--interactive``
+
+ Prompt for any extension metadata that hasn't been provided
+ on the command line
+
+``pack`` [*OPTION*...] [*SOURCE-DIRECTORY*]
+
+ Creates an extension bundle that is suitable for publishing.
+
+ The bundle will always include the required files extension.js
+ and metadata.json, as well as any of the optional stylesheet.css,
+ stylesheet-dark.css, stylesheet-light.css or prefs.js if found.
+ Each additional source that should be included must be specified
+ with ``--extra-source``.
+
+ If the extension includes one or more GSettings schemas, they can
+ either be placed in a schemas/ folder to be picked up automatically,
+ or be specified with ``--schema``.
+
+ Similarily, translations are included automatically when they are
+ located in a po/ folder, otherwise the ``--podir`` option can be
+ used to point to the correct directory. If no gettext domain is
+ provided on the command line, the value of the ``gettext-domain``
+ metadata field is used if it exists, and the extension UUID
+ if not.
+
+ All files are searched in *SOURCE-DIRECTORY* if specified, or
+ the current directory otherwise.
+
+ **Options**
+
+ ``--extra-source``\ =\ *FILE*
+
+ Additional source to include in the bundle
+
+ ``--schema``\ =\ *SCHEMA*
+
+ A GSettings schema that should be compiled and
+ included
+
+ ``--podir``\ =\ *PODIR*
+
+ A directory with translations that should be
+ compiled and included
+
+ ``--gettext-domain``\ =\ *DOMAIN*
+
+ The gettext domain to use for translations
+
+ ``-f``, ``--force``
+
+ Overwrite an existing pack
+
+ ``-o``, ``--out-dir``\ =\ *DIRECTORY*
+
+ The directory where the pack should be created
+
+``install`` [*OPTION*...] *PACK*
+
+ Installs an extension from the bundle *PACK*.
+
+ The command unpacks the extension files and moves them to
+ the expected location in the user's ``$HOME``, so that it
+ will be loaded in the next session.
+
+ It is mainly intended for testing, not as a replacement for
+ the extension website. As extensions have privileged access
+ to the user's session, it is advised to never load extensions
+ from untrusted sources without carefully reviewing their content.
+
+ **Options**
+
+ ``--force``
+
+ Override an existing extension
-*version*::
-Prints the program version.
+``uninstall`` *UUID*
-*enable* 'UUID'::
-Enables the extension identified by 'UUID'.
-+
-The command will not detect any errors from the extension itself, use the
-*info* command to confirm that the extension state is *ACTIVE*.
-+
-If the extension is already enabled, the command will do nothing.
-
-*disable* 'UUID'::
-Disables the extension identified by 'UUID'.
-+
-If the extension is not enabled, the command will do nothing.
-
-*reset* 'UUID'::
-Reset the extension identified by 'UUID'.
-+
-The extension will be disabled in GNOME, but may be enabled by other sessions
-like GNOME Classic.
-
-*info* 'UUID'::
-Show details of the extension identified by 'UUID', including name,
-description and state.
-
-*show* 'UUID'::
-Synonym of info.
-
-*list* ['OPTION'...]::
-Displays a list of installed extensions.
-+
-.Options
- *--user*;;
- Include extensions installed in the user's *$HOME*
-
- *--system*;;
- Include extensions installed in the system
-
- *--enabled*;;
- Include enabled extensions
-
- *--disabled*;;
- Include disabled extensions
-
- *--active*;;
- Only include extensions in active state
-
- *--inactive*;;
- Only include extensions in inactive state
-
- *--prefs*;;
- Only include extensions with preferences
-
- *--updates*;;
- Only include extensions with pending updates
-
- *-d*;;
- *--details*;;
- Show some extra information for each extension
-
-*prefs* 'UUID'::
-Open the preference dialog of the extension identified by 'UUID'.
-
-
-*create* ['OPTION'...]::
-Creates a new extension from a template.
-+
-.Options
- *--name*='NAME':::
- Set the user-visible name in the extension's metadata
- to 'NAME'
-
- *--description*='DESC':::
- Set the description in the extension's metadata to 'DESC'
-
- *--uuid*='UUID':::
- Set the unique extension ID in the metadata to 'UUID'
-
- *--gettext-domain*='DOMAIN':::
- Set the gettext domain used by the extension
-
- *--settings-schema*='SCHEMA':::
- Set the GSettings schema used by the extension
-
- *--template*='TEMPLATE':::
- Use 'TEMPLATE' as base for the new extension
-
- *--prefs*:::
- Include a prefs.js template
-
- *-i*:::
- *--interactive*:::
- Prompt for any extension metadata that hasn't been provided
- on the command line
-
-*pack* ['OPTION'...] ['SOURCE-DIRECTORY']::
-Creates an extension bundle that is suitable for publishing.
-+
-The bundle will always include the required files extension.js
-and metadata.json, as well as any of the optional stylesheet.css,
-stylesheet-dark.css, stylesheet-light.css or prefs.js if found.
-Each additional source that should be included must be specified
-with *--extra-source*.
-+
-If the extension includes one or more GSettings schemas, they can
-either be placed in a schemas/ folder to be picked up automatically,
-or be specified with *--schema*.
-+
-Similarily, translations are included automatically when they are
-located in a po/ folder, otherwise the *--podir* option can be
-used to point to the correct directory. If no gettext domain is
-provided on the command line, the value of the *gettext-domain*
-metadata field is used if it exists, and the extension UUID
-if not.
-+
-All files are searched in 'SOURCE-DIRECTORY' if specified, or
-the current directory otherwise.
-+
-.Options
- *--extra-source*='FILE':::
- Additional source to include in the bundle
-
- *--schema*='SCHEMA':::
- A GSettings schema that should be compiled and
- included
-
- *--podir*='PODIR':::
- A directory with translations that should be
- compiled and included
-
- *--gettext-domain*='DOMAIN':::
- The gettext domain to use for translations
-
- *-f*:::
- *--force*:::
- Overwrite an existing pack
-
- *-o*:::
- *--out-dir*='DIRECTORY':::
- The directory where the pack should be created
-
-*install* ['OPTION'...] 'PACK'::
-Installs an extension from the bundle 'PACK'.
-+
-The command unpacks the extension files and moves them to
-the expected location in the user's *$HOME*, so that it
-will be loaded in the next session.
-+
-It is mainly intended for testing, not as a replacement for
-the extension website. As extensions have privileged access
-to the user's session, it is advised to never load extensions
-from untrusted sources without carefully reviewing their content.
-+
-.Options
- *--force*:::
- Override an existing extension
-
-*uninstall* 'UUID'::
-Uninstalls the extension identified by 'UUID'.
+ Uninstalls the extension identified by *UUID*.
EXIT STATUS
projects / gnome-shell.git / commitdiff